<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>Chapter 3. Berkeley DB Client Driver APIs</title>
    <link rel="stylesheet" href="gettingStarted.css" type="text/css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
    <link rel="start" href="index.html" title="Getting Started with Distributed Berkeley DB Applications" />
    <link rel="up" href="index.html" title="Getting Started with Distributed Berkeley DB Applications" />
    <link rel="prev" href="utilities.html" title="Impacts on Utility Programs" />
    <link rel="next" href="client.connect.html" title="Connecting to a Server without SSL" />
  </head>
  <body>
    <div xmlns="" class="navheader">
      <div class="libver">
        <p>Library Version 12.1.6.2</p>
      </div>
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">Chapter 3. Berkeley DB Client Driver APIs</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="utilities.html">Prev</a> </td>
          <th width="60%" align="center"> </th>
          <td width="20%" align="right"> <a accesskey="n" href="client.connect.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="chapter" lang="en" xml:lang="en">
      <div class="titlepage">
        <div>
          <div>
            <h2 class="title"><a id="client"></a>Chapter 3. Berkeley DB Client Driver APIs</h2>
          </div>
        </div>
      </div>
      <div class="toc">
        <p>
          <b>Table of Contents</b>
        </p>
        <dl>
          <dt>
            <span class="sect1">
              <a href="client.html#sysreq-client">System Requirements</a>
            </span>
          </dt>
          <dt>
            <span class="sect1">
              <a href="client.connect.html">Connecting to a Server without SSL</a>
            </span>
          </dt>
          <dt>
            <span class="sect1">
              <a href="client.connectssl.html">Connecting to a Server with SSL</a>
            </span>
          </dt>
          <dt>
            <span class="sect1">
              <a href="client.admin_api.html">Administrative Functions</a>
            </span>
          </dt>
          <dd>
            <dl>
              <dt>
                <span class="sect2">
                  <a href="client.admin_api.html#client.admin_api.servershutdown">Shutdown the Server</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="client.admin_api.html#client.admin_api.serverping">Using ping</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="client.admin_api.html#client.admin_api.serverversion">Getting the server version</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="client.admin_api.html#client.admin_api.closeHandle">Cleaning up Inactive Handles</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="client.admin_api.html#client.admin_api.deleteEnv">Deleting an Environment and Its Databases</a>
                </span>
              </dt>
            </dl>
          </dd>
          <dt>
            <span class="sect1">
              <a href="client.resource_api.html">Removing and Renaming Objects</a>
            </span>
          </dt>
          <dt>
            <span class="sect1">
              <a href="client.bulk_api.html">Key/Data Pairs and Bulk Operations</a>
            </span>
          </dt>
          <dt>
            <span class="sect1">
              <a href="client.stat_api.html">Statistic Functions</a>
            </span>
          </dt>
          <dt>
            <span class="sect1">
              <a href="client.secondary.html">Secondary Databases</a>
            </span>
          </dt>
          <dt>
            <span class="sect1">
              <a href="client.concurrency.html">Multi-Threaded Applications</a>
            </span>
          </dt>
        </dl>
      </div>
      <p>
        In this chapter, we describe in detail all the aspects of Berkeley DB
        client driver APIs. The client driver APIs are modeled after <span>Java base</span> APIs.
        Therefore a good understanding of <em class="citetitle">Berkeley DB Getting Started with Transaction Processing</em> is
        necessary.
    </p>
      <p> 
        This chapter begins by describing how to connect to a server. It then
        follows with a detailed list of differences between the client driver
        APIs and <span>Java base</span> APIs.
    </p>
      <div class="sect1" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h2 class="title" style="clear: both"><a id="sysreq-client"></a>System Requirements</h2>
            </div>
          </div>
        </div>
        <p> 
            The client driver requires 
            <span>JDK 8 or above, slf4j 1.5.8, log4j
            1.2.14</span>, and Apache Thrift's 
            <span>Java</span> library 0.9.2. All libraries
            are required at both compile and run time. 
        </p>
        <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
          <h3 class="title">Note</h3>
          <p>
                The 3rd party libraries: slf4j, log4j and Apache Thrift are
                bundled in the release package. You do not need to install them
                separately.
            </p>
        </div>
        <p> 
            For Java applications, you should add the
            following jar files under the <code class="literal">lang/thrift/jars</code>
            directory to your applications classpath: 
        </p>
        <div class="itemizedlist">
          <ul type="disc">
            <li>
              <p>
                    <code class="literal">log4j.jar</code>
                </p>
            </li>
            <li>
              <p>
                    <code class="literal">slf4j-api.jar</code>
                </p>
            </li>
            <li>
              <p>
                    <code class="literal">slf4j-log4j12.jar</code>
                </p>
            </li>
            <li>
              <p>
                    <code class="literal">libthrift.jar</code>
                </p>
            </li>
            <li>
              <p>
                    <code class="literal">db_thrift_interface.jar</code>
                </p>
            </li>
            <li>
              <p>
                    <code class="literal">db_thrift_client.jar</code>
                </p>
            </li>
          </ul>
        </div>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="utilities.html">Prev</a> </td>
          <td width="20%" align="center"> </td>
          <td width="40%" align="right"> <a accesskey="n" href="client.connect.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">Impacts on Utility Programs </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> Connecting to a Server without SSL</td>
        </tr>
      </table>
    </div>
  </body>
</html>
